home *** CD-ROM | disk | FTP | other *** search
/ MacWorld 1997 September / Macworld (1997-09).dmg / Shareware World / Comms & Internet / Mail*Link SMTP⁄QM Installer / Disk 3 / Sources & Scripts / Sources / single.man < prev   
Text File  |  1989-05-24  |  4KB  |  147 lines
  1. .if n .ds La '
  2. .if n .ds Ra '
  3. .if t .ds La `
  4. .if t .ds Ra '
  5. .if n .ds Lq "
  6. .if n .ds Rq "
  7. .if t .ds Lq ``
  8. .if t .ds Rq ''
  9. .de Ch
  10. \\$3\\*(Lq\\$1\\*(Rq\\$2
  11. ..
  12. .TH "Single utility" 1
  13. .ds ]W  Release 1.0
  14. .SH NAME
  15. .BR SINGLE
  16.  
  17. .SH DESCRIPTION
  18.  
  19. \fBusage:\fR     \fIsingle [-o output] [-c creator] [-t type] [-s] input\fR
  20.  
  21. .fi
  22. The \fIsingle\fR utility converts the information in the input 
  23. file into 
  24. \fIAppleSingle\fR or \fIAppleDouble\fR format depending on the 
  25. file format of 
  26. the input file. Normally the program will put the output into 
  27. the file 
  28. \fIsingle.out\fR. This can be over ridden with the \fB-o\fR option.
  29. .nf
  30.  
  31. .fi
  32. If the input file is in \fIAppleSingle\fR format then the 
  33. output file will be 
  34. in \fIAppleDouble\fR format unless the \fB-s\fR option is given.
  35. The data fork 
  36. will be in the file \fIoutput\fR and the resource fork will be in the file 
  37. \fI%output\fR.  If the \fB-s\fR option is given then the input file will be split into 
  38. three files; a file called \fIoutput\fR which contains the data fork, a file 
  39. called %\fIoutput\fR which contains the resource information and a file 
  40. called %h\fIoutput\fR which contains just the resource header 
  41. information. The \fIinput\fR file is not modified.
  42. .nf
  43.  
  44. .fi
  45. If the input file is in \fIAppleDouble\fR format, the file will be converted 
  46. into \fIAppleSingle\fR format.  Either resource fork file name or the data 
  47. fork file name can be given as the input file.  This is true even if the 
  48. data fork does not exist.  It is assumed that if the data fork is called 
  49. \fIfilename\fR, the resource fork will be called %\fIfilename\fR.  
  50. .nf
  51.  
  52. .fi
  53. If the input file is in "\fBPACKIT 1\fR" format(packed format), then the 
  54. files are unpacked into \fIAppleSingle\fR files.  In this case no output file 
  55. names are required since the output file names will be the \fIrealnames\fR
  56. of the unpacked files. The \fIrealname\fR is defined in the resource fork of a Macintosh file.
  57. .nf
  58.  
  59. .fi
  60. If the input file is in none of the formats above, then the file is 
  61. converted to \fIAppleSingle\fR format with the data fork being the 
  62. contents of the input file.  The only resource information added to 
  63. the output file are the \fICreator\fR and \fIType\fR fields used in the \fIFinderInfo\fR.  The 
  64. \fICreator\fR and \fIType\fR fields are set to "\fBUNKN\fR" and "\fBTEXT\fR", respectively, 
  65. by default.  These fields can be set to different values by using the \fB-c\fR and the  \fB-t\fR options.
  66. .nf
  67.  
  68. .SH OPTIONS
  69.  
  70. \fB-o \fIoutput file\fR\fR
  71. .in +1i
  72. .fi
  73. The name of the output is not
  74. required when the input file
  75. is in \fIPACKIT 1\fR format. The single
  76. program will default to \fIsingle.out\fR if no
  77. output file is specified.
  78. .nf
  79. .in -1i
  80.  
  81. \fB-s\fR
  82. .in +1i
  83. .fi
  84. Given an \fIAppleSingle\fR file, split the output 
  85. file into three files;  an \fIoutput\fR file 
  86. containing the data fork, a %\fIoutput\fR
  87. files containing the resource 
  88. information, a %h\fIoutput\fR file containing 
  89. the resource header information. The \fB-s\fR does
  90. not apply when the file is in \fIAppleDouble\fR format.
  91. .nf
  92. .in -1i
  93.  
  94. \fB-c Creator\fR
  95. .in +1i
  96. .fi
  97. Set the \fIcreator\fR field in the \fIFinderInfo\fR.  
  98. This option only applies when the input
  99. file is not in \fIAppleSingle\fR, \fIAppleDouble\fR, 
  100. \fIPACKIT 1\fR format(up to 4 characters).
  101. .nf
  102. .in -1i
  103.  
  104. \fB-t Type\fR
  105. .in +1i
  106. .fi
  107. Set the \fItype\fR field in the \fIFinderInfo\fR.  
  108. This option only applies when the input
  109. file is not in \fIAppleSingle\fR, \fIAppleDouble\fR, 
  110. \fIPACKIT 1\fR format(up to 4 characters).
  111. .nf
  112. .in -1i
  113.  
  114. .SH EXAMPLES
  115.  
  116. .nf
  117. .in +1i
  118. single -o \fIoutput\fR \fIapplesinglefile\fR
  119. .in -1i
  120. .fi
  121.  
  122. This will leave the file in \fIAppleDouble\fR format under the file names
  123. \fIoutput\fR and %\fIoutput\fR.
  124. .nf
  125. .in +1i
  126.  
  127. single \fIappledoublefile\fR
  128. .fi
  129. .in -1i
  130.  
  131. This will leave the output in the default output file \fIsingle.out\fR.
  132. .nf
  133. .in +1i
  134.  
  135. single -c ttxt -t TEXT -o \fIteachTextFile\fR \fIunixTextfile\fR
  136.  
  137. .fi
  138. .in -1i
  139. This will take a simple UNIX text file and make it into a \fIAppleDouble Teach Text\fR document.
  140. .nf
  141.  
  142. .SH SEE ALSO
  143.  
  144. .fi
  145. \fIAppleSingle\fR and \fIAppleDouble\fR formats are defined in the document 
  146. "\fIFormats for Apple files in foreign file systems\fR" as released by Apple.
  147.